CALLBACK

成员方法

名称 类型 描述
OnLocalScreenFrame (frame: VideoFrame) => void 本地屏幕视频流采集成功后，会收到此回调。
OnLocalVideoFrame (frame: VideoFrame) => void 本地视频流数据回调
OnRemoteScreenFrame (frame: VideoFrame) => void 远端屏幕共享流数据回调
OnRemoteVideoFrame (frame: VideoFrame) => void 远端视频数据回调
OnWarning (warn: WarningCode) => void 当内部发生警告事件时触发该回调
OnError (error: ErrorCode) => void 当内部发生不可逆转错误时触发该回调
OnAudioMixingFinished () => void 本地音乐文件播放已结束回调。当调用 startAudioMixing 启动的混音文件播放结束后，会触发该回调。
OnAudioMixingStateChanged (id: Number, state: AudioMixingState, error: AudioMixingError) => void 音频混音文件播放状态改变时回调
OnConnectionStateChanged (state: ConnectionState) => void SDK 与信令服务器连接状态改变回调。连接状态改变时触发。
OnNetworkTypeChanged (type: NetworkType) => void SDK 当前网络连接类型改变回调。当 SDK 的当前网络连接类型发生改变时回调该事件。
OnPerformanceAlarms (mode: PerformanceAlarmMode, room_id: String, reason: PerformanceAlarmReason, sourceWantedDataObject: Object) => void 本地未开启发布性能回退，检测到设备性能不足时，收到此回调。
本地开启发布性能回退，因设备性能/网络原因，造成发布性能回退/恢复时，收到此回调。
OnMediaDeviceStateChanged (deviceId: string, deviceType: MediaDeviceType, deviceState: MediaDeviceState, deviceError: MediaDeviceError) => void 媒体设备事件回调。
OnSysStats (stats: SysStats) => void 周期性地发出回调，报告当前cpu与memory使用率
OnJoinRoomResult (roomId: string, userId: string, errorCode: Number, joinType: JoinRoomType, elapsed: number) => void 首次加入房间/重连加入房间的回调。此回调表示用户调用 joinRoom 的结果，根据错误码判断成功/失败以及区别是否为重连。
OnLeaveRoom (stat: Object) => void 离开房间回调。
用户调用 leaveRoom 方法后，SDK 会停止所有的发布订阅流，并在释放所有与通话相关的音视频资源后，通过此回调通知用户离开房间成功。
离开房间后，如果 App 需要使用系统音视频设备，则建议收到此回调后再初始化音视频设备，否则可能由于 SDK 占用音视频设备而导致初始化失败。
OnRoomWarning (warn: number) => void SDK 发生警告回调。
SDK 内部遇到可恢复错误时，在尝试自动恢复的同时，会通过此回调通知用户。此回调事件仅用作通知。
OnRoomError (error: number) => void SDK 发生错误回调。
SDK 内部遇到不可恢复错误时，会通过此回调通知 App，需要 App 根据错误码进行操作或提示用户。
OnAudioVolumeIndication (speakers: AudioVolumeInfo[], totalVolume: number) => void 提示房间内谁正在说话以及说话者音量的回调
OnRoomStats (stats: RtcRoomStats) => void 用户加入房间成功后，每 2s 会收到一次房间内统计信息的回调。
OnLocalStreamStats (stats: LocalStreamStats) => void 反映通话中本地设备发送音/视频流的统计信息以及网络状况的回调，每 2s 触发一次。
OnRemoteStreamStats (stats: RemoteStreamStats) => void 通话中本地设备接收订阅的远端音/视频流的统计信息以及网络状况，每 2s 触发一次。
OnUserJoined (userId: string, elapsed: number) => void 远端用户加入房间回调。
OnUserLeave (userId: string, reason: UserOfflineReasonType) => void 远端用户离开房间回调。
OnUserMuteAudio (userId: string, muteState: MuteState) => void 房间内某用户调用 muteLocalAudio ,改变本地音频发送状态时，房间内其他用户会收到此回调。
OnUserMuteVideo (userId: string, muteState: MuteState) => void 房间内用户暂停/恢复发送视频流时，房间内其他用户会收到此回调。参看 muteLocalVideo 。
OnUserStartAudioCapture (userId: string) => void 房间内的用户调用 startAudioCapture 开启音频采集时，房间内其他用户会收到此回调。
OnUserStopAudioCapture (userId: string) => void 房间内的用户调用 stopAudioCapture 关闭音频采集时，房间内其他用户会收到此回调。
OnFirstLocalAudioFrame (index: StreamIndex) => void 本地采集到第一帧音频帧时，收到该回调
OnFirstRemoteAudioFrame (key: RemoteStreamKey) => void 接收到来自远端某音频流的第一帧时，收到该回调。
OnStreamRemove (stream: ByteStream, reason: StreamRemoveReason) => void 房间内远端流移除回调。
房间内的远端用户停止发布音视频流时，本地用户会收到此回调通知。
OnStreamAdd (stream: ByteStream) => void 房间内新流发布回调。
房间内的远端用户发布新的音视频流时，本地用户会收到此回调通知。
OnSimulcastSubscribeFallback (stream: RemoteStreamSwitch) => void 因发布/订阅性能回退或退出回退状态，订阅的音视频流，发生流的切换时，收到该回调。
OnFirstLocalVideoFrameCaptured (index: StreamIndex, info: VideoFrameInfo) => void 第一帧本地采集的视频/屏幕共享画面在本地视图渲染完成时，收到此回调。
OnLocalVideoSizeChanged (index: StreamIndex, info: VideoFrameInfo) => void 本地视频大小或旋转配置发生改变时，收到此回调。
OnRemoteVideoSizeChanged (key: RemoteStreamKey, stream: VideoFrameInfo) => void 远端视频大小或旋转配置发生改变时，房间内订阅此视频流的用户会收到此回调。
OnFirstRemoteVideoFrameRendered (key: RemoteStreamKey, stream: VideoFrameInfo) => void 第一帧远端视频流在视图上渲染成功后，收到此回调。
OnUserStartVideoCapture (userId: string) => void 房间内的用户调用 startVideoCapture 开启视频采集时，房间内其他用户会收到此回调。
OnUserStopVideoCapture (userId: string) => void 房间内的用户调用 stopVideoCapture 关闭视频采集时，房间内其他用户会收到此回调。
OnLocalAudioStateChanged (state: LocalAudioStreamState, error: LocalAudioStreamError) => void 本地音频的状态发生改变时，该回调通知当前的本地音频状态。
OnRemoteAudioStateChanged (key: RemoteStreamKey, state: RemoteAudioState, reason: RemoteAudioStateChangeReason) => void 用户订阅来自远端的音频流状态发生改变时，会收到此回调，了解当前的远端音频流状态。
OnLocalVideoStateChanged (index: StreamIndex, state: LocalVideoStreamState, error: LocalVideoStreamError) => void 本地视频流的状态发生改变时，收到该事件。
OnRemoteVideoStateChanged (key: RemoteStreamKey, state: RemoteVideoState, reason: RemoteVideoStateChangeReason) => void 远端视频流的状态发生改变时，房间内订阅此流的用户会收到该事件。
OnAudioFrameSendStateChanged (user: RtcUser, state: FirstFrameSendState) => void 音频首帧发送状态改变回调
OnVideoFrameSendStateChanged (user: RtcUser, state: FirstFrameSendState) => void 视频首帧发送状态改变回调
OnScreenVideoFrameSendStateChanged (user: RtcUser, state: FirstFrameSendState) => void 屏幕共享流视频首帧发送状态改变回调
OnAudioFramePlayStateChanged (user: RtcUser, state: FirstFramePlayState) => void 音频首帧播放状态改变回调
OnVideoFramePlayStateChanged (user: RtcUser, state: FirstFramePlayState) => void 视频首帧播放状态改变回调
OnScreenVideoFramePlayStateChanged (user: RtcUser, state: FirstFramePlayState) => void 屏幕共享流视频首帧播放状态改变回调
OnUserEnableLocalAudio (userId: string, enabled: boolean) => void 远端用户开启/关闭音频设备采集时，房间内其他人会收到这个回调。
该回调由远端用户调用 enableLocalAudio 方法触发。
OnRoomMessageReceived (uid: string, message: string) => void 接收到房间内广播消息的回调。
OnUserEnableLocalVideo (userId: string, enabled: boolean) => void 远端用户开启/关闭本地视频采集时回调该事件，当远端用户调用 enableLocalVideo 时，其他用户会触发此回调。
OnRoomMessageSendResult (msgId: number, error: MessageSendResultCode) => void 当调用 sendMessageToRoom 函数发送消息后，回调此条消息的发送结果（反馈）。
OnRoomBinaryMessageReceived (uid: string, message: string) => void 接收到房间内二进制广播消息的回调。
OnUserMessageReceived (userId: string, message: string) => void 点对点消息回调。接收到同一房间内 uid 所属用户发来消息时触发。
OnUserMessageSendResult (msgId: number, error: MessageSendResultCode) => void 当调用 sendMessageToUser 函数发送消息后，回调此条消息的发送结果（反馈）。
OnUserBinaryMessageReceived (uid: string, message: string) => void 单个用户接收到同一房间内其他 uid 所属用户发来二进制消息的回调（P2P）。
OnSEIMessageReceived (stream_key: RemoteStreamKey, message: String) => void 收到通过 sendSEIMessage 发送的带有 SEI 消息的视频帧时，收到此回调
OnStreamMixingEvent (event: StreamMixingEvent, event_data: String, error: number, mix_type: StreamMixingType) => void 通知转推直播关键事件
OnStreamMixingVideoFrame (video_frame: VideoFrame) => void 合流视频帧回调
OnRecordingStateUpdate (type: StreamIndex, state: number, error_code: number, info: RecordingInfo) => void 获取本地录制状态回调。
该回调由 startFileRecording 或 StopFileRecording 触发。
OnRecordingProgressUpdate (type: StreamIndex, process: RecordingProgress, info: RecordingInfo) => void 本地录制进度回调。 该回调由 StartFileRecording 触发，录制状态正常时，系统每秒钟都会通过该回调提示录制进度。
OnLoginResult (uid: string, error_code: number, elapsed: number) => void 登录结果回调
OnLogout () => void 登出结果回调
OnServerParamsSetResult (error: number) => void 设置业务服务器参数的返回结果
OnGetPeerOnlineStatus (peer_user_id: string, status: number) => void 查询对端或本端用户登录状态的返回结果
OnUserMessageReceivedOutsideRoom (uid: string, message: string) => void 收到房间外用户调用 sendUserMessageOutsideRoom 发来的文本消息时，会收到此回调
OnUserBinaryMessageReceivedOutsideRoom (uid: string, message: string) => void 收到房间外用户调用 SendUserBinaryMessageOutsideRoom 发来的二进制消息时，会收到此回调
OnUserMessageSendResultOutsideRoom (msgid: number, error: number) => void 给房间外指定的用户发送消息的回调
OnServerMessageSendResult (msgid: number, error: number) => void 给业务服务器发送消息的回调
OnRecordAudioFrame (audio_frame: any) => void 返回麦克风录制的音频数据
OnPlaybackAudioFrame (audio_frame: any) => void 返回远端所有用户混音后的音频数据
OnMixedAudioFrame (audio_frame: any) => void 返回本地麦克风录制和远端所有用户混音后的音频数据
OnASRSuccess () => void 语音识别服务开启成功回调
OnMessage (message: string) => void 语音转文字成功回调，该回调返回识别后的全量消息。
OnASRError (error_code: number, error_message: string) => void 当语音识别服务内部发生错误事件时触发该回调。
OnLiveTranscodingResult (url: string, error: number) => void 直播推流转码错误回调。
用户调用 startLiveTranscoding 接口启动直播推流转码功能后，启动结果和推流过程中 的错误均会通过此回调方法通知用户。

方法详情

OnLocalScreenFrame

本地屏幕视频流采集成功后，会收到此回调。

(frame: VideoFrame) => void

参数

名称 类型 必选 默认值 描述
frame VideoFrame 是 视频数据

注意

对于回调的视频数据，你可以进行自定义渲染。

OnLocalVideoFrame

本地视频流数据回调

(frame: VideoFrame) => void

参数

名称 类型 必选 默认值 描述
frame VideoFrame 是 视频数据

OnRemoteScreenFrame

远端屏幕共享流数据回调

(frame: VideoFrame) => void

参数

名称 类型 必选 默认值 描述
frame VideoFrame 是 视频数据

OnRemoteVideoFrame

远端视频数据回调

(frame: VideoFrame) => void

参数

名称 类型 必选 默认值 描述
frame VideoFrame 是 视频数据

OnWarning

当内部发生警告事件时触发该回调

(warn: WarningCode) => void

参数

名称 类型 必选 默认值 描述
warn WarningCode 是 警告标识码

OnError

当内部发生不可逆转错误时触发该回调

(error: ErrorCode) => void

参数

名称 类型 必选 默认值 描述
error ErrorCode 是 错误标识码

OnAudioMixingFinished

本地音乐文件播放已结束回调。当调用 startAudioMixing 启动的混音文件播放结束后，会触发该回调。

() => void

OnAudioMixingStateChanged

音频混音文件播放状态改变时回调

(id: Number, state: AudioMixingState, error: AudioMixingError) => void

参数

名称 类型 必选 默认值 描述
id Number 是 混音 ID
state AudioMixingState 是 混音状态
error AudioMixingError 是 错误码

注意

OnConnectionStateChanged

SDK 与信令服务器连接状态改变回调。连接状态改变时触发。

(state: ConnectionState) => void

参数

名称 类型 必选 默认值 描述
state ConnectionState 是 当前 SDK 与信令服务器的连接状态

OnNetworkTypeChanged

SDK 当前网络连接类型改变回调。当 SDK 的当前网络连接类型发生改变时回调该事件。

(type: NetworkType) => void

参数

名称 类型 必选 默认值 描述
type NetworkType 是 SDK 当前的网络连接类型

OnPerformanceAlarms

本地未开启发布性能回退，检测到设备性能不足时，收到此回调。
本地开启发布性能回退，因设备性能/网络原因，造成发布性能回退/恢复时，收到此回调。

(mode: PerformanceAlarmMode, room_id: String, reason: PerformanceAlarmReason, sourceWantedDataObject: Object) => void

参数

名称 类型 必选 默认值 描述
mode PerformanceAlarmMode 是 指示本地是否开启发布回退功能
  • 当发布端未开启发布性能回退时，mode 值为 kPerformanceAlarmModeNormal。
  • 当发布端开启发布性能回退时，mode 值为 kPerformanceAlarmModeSimulcast。
    		•
    room_id String 是
  • 未开启发布性能回退时，room_id 为空
  • 开启发布性能回退时，room_id 是告警影响的房间 ID。
    		•
    reason PerformanceAlarmReason 是 告警原因
    sourceWantedDataObject Object 是 性能回退相关数据

    OnMediaDeviceStateChanged

    媒体设备事件回调。

    (deviceId: string, deviceType: MediaDeviceType, deviceState: MediaDeviceState, deviceError: MediaDeviceError) => void

    参数

    名称 类型 必选 默认值 描述
    deviceId string 是 设备 id
    deviceType MediaDeviceType 是 媒体设备类型
    deviceState MediaDeviceState 是 媒体设备状态类型
    deviceError MediaDeviceError 是 媒体设备错误类型

    注意

    该回调包括了系统内媒体设备的事件通知，如设备的插入、拔出事件通知。

    OnSysStats

    周期性地发出回调，报告当前cpu与memory使用率

    (stats: SysStats) => void

    参数

    名称 类型 必选 默认值 描述
    stats SysStats 是 返回包含当前系统状态信息的结构体

    OnJoinRoomResult

    首次加入房间/重连加入房间的回调。此回调表示用户调用 joinRoom 的结果，根据错误码判断成功/失败以及区别是否为重连。

    (roomId: string, userId: string, errorCode: Number, joinType: JoinRoomType, elapsed: number) => void

    参数

    名称 类型 必选 默认值 描述
    roomId string 是 房间 ID。
    userId string 是 用户 ID。
    errorCode Number 是 用户加入房间回调的状态码。 0: 加入房间成功；
    joinType JoinRoomType 是 用户加入房间的类型，标识用户第一次加入或断网重连加入。参看 joinRoomType 。
    elapsed number 是 重连耗时。本地用户从连接断开到重连成功所经历的时间间隔，单位为 ms，加入房间失败为 -1

    OnLeaveRoom

    离开房间回调。
    用户调用 leaveRoom 方法后，SDK 会停止所有的发布订阅流，并在释放所有与通话相关的音视频资源后，通过此回调通知用户离开房间成功。
    离开房间后，如果 App 需要使用系统音视频设备，则建议收到此回调后再初始化音视频设备，否则可能由于 SDK 占用音视频设备而导致初始化失败。

    (stat: Object) => void

    参数

    名称 类型 必选 默认值 描述
    stat Object 是 本次通话的统计数据 。

    OnRoomWarning

    SDK 发生警告回调。
    SDK 内部遇到可恢复错误时，在尝试自动恢复的同时，会通过此回调通知用户。此回调事件仅用作通知。 

    (warn: number) => void

    参数

    名称 类型 必选 默认值 描述
    warn number 是 警告码，参看 WarningCode 。

    OnRoomError

    SDK 发生错误回调。
    SDK 内部遇到不可恢复错误时，会通过此回调通知 App，需要 App 根据错误码进行操作或提示用户。 

    (error: number) => void

    参数

    名称 类型 必选 默认值 描述
    error number 是 错误码，参看 ErrorCode 。

    OnAudioVolumeIndication

    提示房间内谁正在说话以及说话者音量的回调

    (speakers: AudioVolumeInfo[], totalVolume: number) => void

    参数

    名称 类型 必选 默认值 描述
    speakers AudioVolumeInfo[] 是 房间内所有用户ID, 以及每个用户对应的音量，包括发送流和接收流。详见：AudioVolumeInfo 。
    totalVolume number 是 音频源总音量，只包含接收流

    注意

    OnRoomStats

    用户加入房间成功后，每 2s 会收到一次房间内统计信息的回调。

    (stats: RtcRoomStats) => void

    参数

    名称 类型 必选 默认值 描述
    stats RtcRoomStats 是 当前 RtcEngine 统计数据

    OnLocalStreamStats

    反映通话中本地设备发送音/视频流的统计信息以及网络状况的回调，每 2s 触发一次。

    (stats: LocalStreamStats) => void

    参数

    名称 类型 必选 默认值 描述
    stats LocalStreamStats 是 当前 RtcEngine 统计数据

    OnRemoteStreamStats

    通话中本地设备接收订阅的远端音/视频流的统计信息以及网络状况，每 2s 触发一次。

    (stats: RemoteStreamStats) => void

    参数

    名称 类型 必选 默认值 描述
    stats RemoteStreamStats 是 当前 RtcEngine 统计数据

    OnUserJoined

    远端用户加入房间回调。

    (userId: string, elapsed: number) => void

    参数

    名称 类型 必选 默认值 描述
    userId string 是 用户ID 。新加入的远端用户的用户ID 。
    elapsed number 是 本地用户调用 joinChannel 加入房间到收到该事件经历的时间，单位为 ms 。

    注意

    OnUserLeave

    远端用户离开房间回调。

    (userId: string, reason: UserOfflineReasonType) => void

    参数

    名称 类型 必选 默认值 描述
    userId string 是 用户ID 。离开房间的远端用户的用户ID 。
    reason UserOfflineReasonType 是 用户离开的原因

    注意

    OnUserMuteAudio

    房间内某用户调用 muteLocalAudio ,改变本地音频发送状态时，房间内其他用户会收到此回调。

    (userId: string, muteState: MuteState) => void

    参数

    名称 类型 必选 默认值 描述
    userId string 是 改变本地音频发送状态的用户 ID
    muteState MuteState 是 发送状态

    OnUserMuteVideo

    房间内用户暂停/恢复发送视频流时，房间内其他用户会收到此回调。参看 muteLocalVideo 。

    (userId: string, muteState: MuteState) => void

    参数

    名称 类型 必选 默认值 描述
    userId string 是 暂停/恢复发送视频流的用户 ID。
    muteState MuteState 是 暂停/恢复发送视频流的状态

    OnUserStartAudioCapture

    房间内的用户调用 startAudioCapture 开启音频采集时，房间内其他用户会收到此回调。

    (userId: string) => void

    参数

    名称 类型 必选 默认值 描述
    userId string 是 开启音频采集的远端用户 ID

    OnUserStopAudioCapture

    房间内的用户调用 stopAudioCapture 关闭音频采集时，房间内其他用户会收到此回调。

    (userId: string) => void

    参数

    名称 类型 必选 默认值 描述
    userId string 是 关闭音频采集的远端用户 ID

    OnFirstLocalAudioFrame

    本地采集到第一帧音频帧时，收到该回调

    (index: StreamIndex) => void

    参数

    名称 类型 必选 默认值 描述
    index StreamIndex 是 音频流属性

    OnFirstRemoteAudioFrame

    接收到来自远端某音频流的第一帧时，收到该回调。

    (key: RemoteStreamKey) => void

    参数

    名称 类型 必选 默认值 描述
    key RemoteStreamKey 是 远端音频流信息

    注意

    用户刚收到房间内每一路音频流时，都会收到该回调。

    OnStreamRemove

    房间内远端流移除回调。
    房间内的远端用户停止发布音视频流时，本地用户会收到此回调通知。

    (stream: ByteStream, reason: StreamRemoveReason) => void

    参数

    名称 类型 必选 默认值 描述
    stream ByteStream 是 流的属性
    reason StreamRemoveReason 是 远端流移除的原因

    OnStreamAdd

    房间内新流发布回调。
    房间内的远端用户发布新的音视频流时，本地用户会收到此回调通知。

    (stream: ByteStream) => void

    参数

    名称 类型 必选 默认值 描述
    stream ByteStream 是 流的属性

    OnSimulcastSubscribeFallback

    因发布/订阅性能回退或退出回退状态，订阅的音视频流，发生流的切换时，收到该回调。

    (stream: RemoteStreamSwitch) => void

    参数

    名称 类型 必选 默认值 描述
    stream RemoteStreamSwitch 是 流切换信息

    注意

    你必须先通过 API 或控制台设置音视频流订阅回退功能时，你才能收到此回调。

    OnFirstLocalVideoFrameCaptured

    第一帧本地采集的视频/屏幕共享画面在本地视图渲染完成时，收到此回调。

    (index: StreamIndex, info: VideoFrameInfo) => void

    参数

    名称 类型 必选 默认值 描述
    index StreamIndex 是 流属性
    info VideoFrameInfo 是 视频信息

    OnLocalVideoSizeChanged

    本地视频大小或旋转配置发生改变时，收到此回调。

    (index: StreamIndex, info: VideoFrameInfo) => void

    参数

    名称 类型 必选 默认值 描述
    index StreamIndex 是 流属性
    info VideoFrameInfo 是 视频帧信息

    OnRemoteVideoSizeChanged

    远端视频大小或旋转配置发生改变时，房间内订阅此视频流的用户会收到此回调。

    (key: RemoteStreamKey, stream: VideoFrameInfo) => void

    参数

    名称 类型 必选 默认值 描述
    key RemoteStreamKey 是 远端流信息
    stream VideoFrameInfo 是 视频帧信息

    OnFirstRemoteVideoFrameRendered

    第一帧远端视频流在视图上渲染成功后，收到此回调。

    (key: RemoteStreamKey, stream: VideoFrameInfo) => void

    参数

    名称 类型 必选 默认值 描述
    key RemoteStreamKey 是 远端流信息
    stream VideoFrameInfo 是 视频帧信息

    OnUserStartVideoCapture

    房间内的用户调用 startVideoCapture 开启视频采集时，房间内其他用户会收到此回调。

    (userId: string) => void

    参数

    名称 类型 必选 默认值 描述
    userId string 是 开启视频采集的远端用户 ID

    OnUserStopVideoCapture

    房间内的用户调用 stopVideoCapture 关闭视频采集时，房间内其他用户会收到此回调。

    (userId: string) => void

    参数

    名称 类型 必选 默认值 描述
    userId string 是 关闭视频采集的远端用户 ID

    OnLocalAudioStateChanged

    本地音频的状态发生改变时，该回调通知当前的本地音频状态。

    (state: LocalAudioStreamState, error: LocalAudioStreamError) => void

    参数

    名称 类型 必选 默认值 描述
    state LocalAudioStreamState 是 本地音频设备的状态
    error LocalAudioStreamError 是 本地音频状态改变时的错误码

    OnRemoteAudioStateChanged

    用户订阅来自远端的音频流状态发生改变时，会收到此回调，了解当前的远端音频流状态。

    (key: RemoteStreamKey, state: RemoteAudioState, reason: RemoteAudioStateChangeReason) => void

    参数

    名称 类型 必选 默认值 描述
    key RemoteStreamKey 是 远端流信息
    state RemoteAudioState 是 远端音频流状态
    reason RemoteAudioStateChangeReason 是 远端音频流状态改变的原因

    OnLocalVideoStateChanged

    本地视频流的状态发生改变时，收到该事件。

    (index: StreamIndex, state: LocalVideoStreamState, error: LocalVideoStreamError) => void

    参数

    名称 类型 必选 默认值 描述
    index StreamIndex 是 音/视频属性
    state LocalVideoStreamState 是 本地视频流状态
    error LocalVideoStreamError 是 本地视频状态改变时的错误码

    OnRemoteVideoStateChanged

    远端视频流的状态发生改变时，房间内订阅此流的用户会收到该事件。

    (key: RemoteStreamKey, state: RemoteVideoState, reason: RemoteVideoStateChangeReason) => void

    参数

    名称 类型 必选 默认值 描述
    key RemoteStreamKey 是 远端视频流的信息，房间、用户 ID、流属性等。
    state RemoteVideoState 是 远端视频流状态
    reason RemoteVideoStateChangeReason 是 远端视频流状态改变的原因

    OnAudioFrameSendStateChanged

    音频首帧发送状态改变回调

    (user: RtcUser, state: FirstFrameSendState) => void

    参数

    名称 类型 必选 默认值 描述
    user RtcUser 是 本地用户信息
    state FirstFrameSendState 是 首帧发送状态

    OnVideoFrameSendStateChanged

    视频首帧发送状态改变回调

    (user: RtcUser, state: FirstFrameSendState) => void

    参数

    名称 类型 必选 默认值 描述
    user RtcUser 是 本地用户信息
    state FirstFrameSendState 是 首帧发送状态

    OnScreenVideoFrameSendStateChanged

    屏幕共享流视频首帧发送状态改变回调

    (user: RtcUser, state: FirstFrameSendState) => void

    参数

    名称 类型 必选 默认值 描述
    user RtcUser 是 本地用户信息
    state FirstFrameSendState 是 首帧发送状态

    OnAudioFramePlayStateChanged

    音频首帧播放状态改变回调

    (user: RtcUser, state: FirstFramePlayState) => void

    参数

    名称 类型 必选 默认值 描述
    user RtcUser 是 远端用户信息
    state FirstFramePlayState 是 首帧播放状态

    OnVideoFramePlayStateChanged

    视频首帧播放状态改变回调

    (user: RtcUser, state: FirstFramePlayState) => void

    参数

    名称 类型 必选 默认值 描述
    user RtcUser 是 远端用户信息
    state FirstFramePlayState 是 首帧播放状态

    OnScreenVideoFramePlayStateChanged

    屏幕共享流视频首帧播放状态改变回调

    (user: RtcUser, state: FirstFramePlayState) => void

    参数

    名称 类型 必选 默认值 描述
    user RtcUser 是 远端用户信息
    state FirstFramePlayState 是 首帧播放状态

    OnUserEnableLocalAudio

    远端用户开启/关闭音频设备采集时，房间内其他人会收到这个回调。
    该回调由远端用户调用 enableLocalAudio 方法触发。

    (userId: string, enabled: boolean) => void

    参数

    名称 类型 必选 默认值 描述
    userId string 是 远端用户ID
    enabled boolean 是 该用户是否开启了音频设备采集

    OnRoomMessageReceived

    接收到房间内广播消息的回调。

    (uid: string, message: string) => void

    参数

    名称 类型 必选 默认值 描述
    uid string 是 远端用户ID
    message string 是 收到的消息内容

    注意

    同一房间内其他用户调用 sendMessageToRoom 发送广播消息时会收到该回调。

    OnUserEnableLocalVideo

    远端用户开启/关闭本地视频采集时回调该事件，当远端用户调用 enableLocalVideo 时，其他用户会触发此回调。

    (userId: string, enabled: boolean) => void

    参数

    名称 类型 必选 默认值 描述
    userI string 是 用户ID，提示是哪个用户的视频流。
    enabled boolean 是 是否启用本地视频功能。
  • true：该用户已启用本地视频功能。启用后，其他用户可以接收到该用户的视频流。
  • false：该用户已关闭视频功能。关闭后，该用户仍然可以接收其他用户的视频流，但其他用户接收不到该用户的视频流。

    • 注意

    提示有其他用户启用/关闭了本地视频功能。

    OnRoomMessageSendResult

    当调用 sendMessageToRoom 函数发送消息后，回调此条消息的发送结果（反馈）。

    (msgId: number, error: MessageSendResultCode) => void

    参数

    名称 类型 必选 默认值 描述
    msgId number 是 本条消息的 ID
    error MessageSendResultCode 是 消息发送结果

    OnRoomBinaryMessageReceived

    接收到房间内二进制广播消息的回调。

    (uid: string, message: string) => void

    参数

    名称 类型 必选 默认值 描述
    uid string 是 消息发送者 ID
    message string 是 收到的二进制消息内容

    注意

    同一房间内其他用户调用 sendRoomBinaryMessage 发送二进制广播消息时会收到该回调。

    OnUserMessageReceived

    点对点消息回调。接收到同一房间内 uid 所属用户发来消息时触发。

    (userId: string, message: string) => void

    参数

    名称 类型 必选 默认值 描述
    userId string 是 消息发送者 ID 。
    message string 是 收到的消息内容。

    注意

    同一房间内其他用户调用 sendMessageToUser 发送消息给本地用户时会收到该回调。

    OnUserMessageSendResult

    当调用 sendMessageToUser 函数发送消息后，回调此条消息的发送结果（反馈）。

    (msgId: number, error: MessageSendResultCode) => void

    参数

    名称 类型 必选 默认值 描述
    msgId number 是 本条消息的 ID
    error MessageSendResultCode 是 消息发送结果

    OnUserBinaryMessageReceived

    单个用户接收到同一房间内其他 uid 所属用户发来二进制消息的回调（P2P）。

    (uid: string, message: string) => void

    参数

    名称 类型 必选 默认值 描述
    uid string 是 消息发送者 ID 。
    message string 是 收到的二进制消息内容。

    注意

    同一房间内其他用户调用 sendUserBinaryMessage 发送二进制消息给本地用户时，本地用户会收到该回调。

    OnSEIMessageReceived

    收到通过 sendSEIMessage 发送的带有 SEI 消息的视频帧时，收到此回调

    (stream_key: RemoteStreamKey, message: String) => void

    参数

    名称 类型 必选 默认值 描述
    stream_key RemoteStreamKey 是 包含 SEI 发送者的用户名，所在的房间名和媒体流
    message String 是 收到的 SEI 消息内容

    OnStreamMixingEvent

    通知转推直播关键事件

    (event: StreamMixingEvent, event_data: String, error: number, mix_type: StreamMixingType) => void

    参数

    名称 类型 必选 默认值 描述
    event StreamMixingEvent 是 事件类型
    event_data String 是 事件参数
    error number 是 错误类型
    mix_type StreamMixingType 是 合流类型

    OnStreamMixingVideoFrame

    合流视频帧回调

    (video_frame: VideoFrame) => void

    参数

    名称 类型 必选 默认值 描述
    video_frame VideoFrame 是 视频帧

    注意

    收到该回调的周期与视频的帧间隔一致

    OnRecordingStateUpdate

    获取本地录制状态回调。
    该回调由 startFileRecording 或 StopFileRecording 触发。

    (type: StreamIndex, state: number, error_code: number, info: RecordingInfo) => void

    参数

    名称 类型 必选 默认值 描述
    type StreamIndex 是 录制流的流属性
    state number 是 录制状态
    error_code number 是 录制错误码
    info RecordingInfo 是 录制文件的详细信息

    OnRecordingProgressUpdate

    本地录制进度回调。 该回调由 StartFileRecording 触发，录制状态正常时，系统每秒钟都会通过该回调提示录制进度。

    (type: StreamIndex, process: RecordingProgress, info: RecordingInfo) => void

    参数

    名称 类型 必选 默认值 描述
    type StreamIndex 是 录制流的流属性
    process RecordingProgress 是 录制进度
    info RecordingInfo 是 录制文件的详细信息

    OnLoginResult

    登录结果回调

    (uid: string, error_code: number, elapsed: number) => void

    参数

    名称 类型 必选 默认值 描述
    uid string 是 登录用户 ID
    error_code number 是 登录结果
    elapsed number 是 从调用 Login 接口开始到返回结果所用时长，单位为 ms。

    注意

    调用 login 后，会收到此回调。

    OnLogout

    登出结果回调

    () => void

    注意

    调用 logout 后，会收到此回调。

    OnServerParamsSetResult

    设置业务服务器参数的返回结果

    (error: number) => void

    参数

    名称 类型 必选 默认值 描述
    error number 是 设置结果
  • 返回 200，设置成功
  • 返回其他，设置失败
    		•

    注意

    调用 setServerParams 后，会收到此回调。

    OnGetPeerOnlineStatus

    查询对端或本端用户登录状态的返回结果

    (peer_user_id: string, status: number) => void

    参数

    名称 类型 必选 默认值 描述
    peer_user_id string 是 需要查询的用户 ID
    status number 是 查询的用户登录状态

    注意

    必须先调用 getPeerOnlineStatus ，才能收到此回调。

    OnUserMessageReceivedOutsideRoom

    收到房间外用户调用 sendUserMessageOutsideRoom 发来的文本消息时，会收到此回调

    (uid: string, message: string) => void

    参数

    名称 类型 必选 默认值 描述
    uid string 是 消息发送者 ID
    message string 是 收到的文本消息内容

    OnUserBinaryMessageReceivedOutsideRoom

    收到房间外用户调用 SendUserBinaryMessageOutsideRoom 发来的二进制消息时，会收到此回调

    (uid: string, message: string) => void

    参数

    名称 类型 必选 默认值 描述
    uid string 是 消息发送者 ID
    message string 是 收到的二进制消息内容

    OnUserMessageSendResultOutsideRoom

    给房间外指定的用户发送消息的回调

    (msgid: number, error: number) => void

    参数

    名称 类型 必选 默认值 描述
    msgid number 是 本条消息的 ID。所有的 P2P 和 P2Server 消息共用一个 ID 序列。
    error number 是 消息发送结果

    注意

    当调用 sendUserMessageOutsideRoom 或 sendUserBinaryMessageOutsideRoom 发送消息后，会收到此回调。

    OnServerMessageSendResult

    给业务服务器发送消息的回调

    (msgid: number, error: number) => void

    参数

    名称 类型 必选 默认值 描述
    msgid number 是 本条消息的 ID。所有的 P2P 和 P2Server 消息共用一个 ID 序列。
    error number 是 消息发送结果

    注意

    当调用 SendServerMessage 或 sendServerBinaryMessage 接口发送消息后，会收到此回调。

    OnRecordAudioFrame

    返回麦克风录制的音频数据

    (audio_frame: any) => void

    参数

    名称 类型 必选 默认值 描述
    audio_frame AudioFrame 是 麦克风录制的音频数据

    OnPlaybackAudioFrame

    返回远端所有用户混音后的音频数据

    (audio_frame: any) => void

    参数

    名称 类型 必选 默认值 描述
    audio_frame AudioFrame 是 远端所有用户混音后的音频数据

    OnMixedAudioFrame

    返回本地麦克风录制和远端所有用户混音后的音频数据

    (audio_frame: any) => void

    参数

    名称 类型 必选 默认值 描述
    audio_frame AudioFrame 是 本地麦克风录制和远端所有用户混音后的音频数据

    OnASRSuccess

    语音识别服务开启成功回调

    () => void

    OnMessage

    语音转文字成功回调，该回调返回识别后的全量消息。

    (message: string) => void

    参数

    名称 类型 必选 默认值 描述
    message string 是 识别完成后得到的文字消息

    注意

    若识别过程中发生了网络连接中断，则重连后回调的信息中只包含重连后识别的文字消息，不再包含上一次连接后识别的消息。

    OnASRError

    当语音识别服务内部发生错误事件时触发该回调。

    (error_code: number, error_message: string) => void

    参数

    名称 类型 必选 默认值 描述
    error_code number 是 错误码
  • <0: 参数错误或 API 调用顺序错误，参看 RTCASRErrorCode ；
  • >0: 参看 语音识别服务错误码
    • error_message string 是 错误原因说明

    OnLiveTranscodingResult

    直播推流转码错误回调。
    用户调用 startLiveTranscoding 接口启动直播推流转码功能后，启动结果和推流过程中 的错误均会通过此回调方法通知用户。

    (url: string, error: number) => void

    参数

    名称 类型 必选 默认值 描述
    url string 是 推流地址的 URL。
    error number 是 直播推流转码功能错误码
    0：推流成功。
    1：推流参数错误。
    2：和 RTC 服务端建立连接失败。会自动重连。
    3：合流服务中间过程存在错误，建议重试。
    4：推流失败，可以等待服务端重新推流。